Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script to automatically generate Markdown API docs from source code. #1870

Merged
merged 6 commits into from
Sep 30, 2024
Merged

Script to automatically generate Markdown API docs from source code. #1870

merged 6 commits into from
Sep 30, 2024

Conversation

devvaannsh
Copy link
Contributor

Changes :-

  1. Updated JavaScript files in the src directory to resolve compatibility issues with Docusaurus.
  2. Modified package.json (Script can now be executed using the command :-
    npm run createMDDocs )
  3. Update the script to generate Markdown files from the source code.

const outputDir = path.join(MD_FILES_DIR, relativePath);
createDir(outputDir);
const outputFileName = path.join(outputDir, `${fileName}.md`);
execSync(`npx jsdoc-to-markdown ${file} > ${outputFileName}`);

Check warning

Code scanning / CodeQL

Shell command built from environment values Medium

This shell command depends on an uncontrolled
file name
.
src/worker/IndexingWorker.js Outdated Show resolved Hide resolved
src/utils/FeatureGate.js Outdated Show resolved Hide resolved
src/utils/ExtensionInterface.js Outdated Show resolved Hide resolved
src/utils/ExtensionInterface.js Outdated Show resolved Hide resolved
src/utils/EventManager.js Outdated Show resolved Hide resolved
src/utils/EventManager.js Outdated Show resolved Hide resolved
src/features/QuickViewManager.js Outdated Show resolved Hide resolved
Copy link

@abose abose merged commit 9787df6 into phcode-dev:main Sep 30, 2024
2 checks passed
@abose
Copy link
Member

abose commented Sep 30, 2024

LGTM. Merged.
Thanks for contributing @devvaannsh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants